reverseproxy: Rewrite requests and responses for websocket over http2 by WeidiDeng · Pull Request #6567 · caddyserver/caddy

WeidiDeng · 2024-09-10T02:48:55Z

Supports reverse proxying h2 websockets to backends. Fix 5565.

Requires upstream support, but can be tested with xcaddy build reverse-proxy-h2-websocket --replace golang.org/x/net=github.com/WeidiDeng/net@websocket-http2

mholt · 2024-09-10T14:39:53Z

Very neat, nice work @WeidiDeng 💯

bt90 · 2024-09-29T16:32:02Z

I'm not 100% sure but a regular HTTP/2 GET request should contain the new setting parameter as outlined in RFC8441 Section 3?

[0-0] == Info: [HTTP/2] [0] ingress: read 45 bytes
[0-0] == Info: [HTTP/2] [0] <- FRAME[SETTINGS, len=36]
[0-0] == Info: [HTTP/2] [0] MAX_CONCURRENT_STREAMS: 250
[0-0] == Info: [HTTP/2] [0] ENABLE_PUSH: TRUE
[0-0] == Info: [HTTP/2] [0] notify MAX_CONCURRENT_STREAMS: 250
[0-0] == Info: [HTTP/2] [0] -> FRAME[SETTINGS, len=18]
[0-0] == Info: [HTTP/2] [0] -> FRAME[SETTINGS, ack=1]
[0-0] == Info: [HTTP/2] [0] -> FRAME[WINDOW_UPDATE, incr=1048510465]
[0-0] => Send SSL data, 5 bytes (0x5)
0000: 17 03 03 00 5a                                  ....Z
[0-0] => Send SSL data, 1 bytes (0x1)
0000: 17                                              .
[0-0] == Info: [HTTP/2] [0] egress: wrote 73 bytes
[0-0] == Info: [HTTP/2] cf_connect() -> 0, 1,
[0-0] == Info: using HTTP/2
[0-0] == Info: [HTTP/2] [1] OPENED stream for https://xxxxxxx.xxx/

Tested via curl:

curl --trace request.dump --trace-config http/2 https://example.com

WeidiDeng · 2024-09-30T01:00:58Z

i'm not sure about curl debug dump. But I tested this with my Chrome and it works. The setting frame is send at the start of a new http2 connection, so it's sent regardless of the method client uses.

Even without my patch, golang http2 sends the following settings:

The output doesn't list all of them.

bt90 · 2024-10-05T09:38:55Z

Successfully tested in Firefox 👍

WeidiDeng · 2024-11-26T01:12:34Z

Upstream merged in 9a51899. Waiting for the next release.

mholt

Thanks for working on this Weidi! Cool feature. I am not sure I 100% fully understand every line of this, but after a scan I don't see any red flags that stick out to me.

WeidiDeng · 2024-12-05T01:14:50Z

golang/x/net v0.32.0 is out.

bt90 · 2024-12-05T08:51:23Z

Is this a simple version bump which could be done in this PR or are there any side effects?

WeidiDeng · 2024-12-05T11:06:12Z

It's in another pr.

francislavoie · 2024-12-05T22:54:59Z

So this is ready to merge @WeidiDeng ?

WeidiDeng · 2024-12-06T00:05:57Z

Yes @francislavoie

mholt

Thanks Weidi. Let's give it a shot!

jeda · 2024-12-11T05:14:12Z

I updated to latest master which included this commit, and it broke WebSocket reverse-proxying towards an HTTP/1.1 backend on Firefox for me.
The connection to wss://[...] was interrupted while the page was loading.

bt90 · 2024-12-11T06:02:20Z

See #6733

WeidiDeng · 2024-12-11T06:07:45Z

@JeDaYoshi try xcaddy build encode-connect to see if it's fixed, or use the following request matchers

@not_h2_ws not {
    header :protocol *
    method CONNECT
    protocol http/2
}
encode @not_h2_ws zstd gzip

jeda · 2024-12-11T06:15:35Z

I should check PRs/issues properly before commenting things.. My apologies.

@WeidiDeng encode-connect / #6738 seems to be working for me.

…#6567) * reverse proxy: rewrite requests and responses for websocket over http2 * delete protocol pseudo-header * modify cloned requests * set request variable to track if it's a h2 websocket * use request bodu * rewrite request body * use WebSocket instead of Websocket in the headers * use logger check for zap loggers * fix lint

…caddyserver#6567) * reverse proxy: rewrite requests and responses for websocket over http2 * delete protocol pseudo-header * modify cloned requests * set request variable to track if it's a h2 websocket * use request bodu * rewrite request body * use WebSocket instead of Websocket in the headers * use logger check for zap loggers * fix lint

WeidiDeng added 6 commits September 10, 2024 10:44

reverse proxy: rewrite requests and responses for websocket over http2

389cec4

delete protocol pseudo-header

8eaa94b

modify cloned requests

67778fc

set request variable to track if it's a h2 websocket

460c3e5

use request bodu

feac4b0

rewrite request body

ebd589c

WeidiDeng mentioned this pull request Sep 10, 2024

Support WebSockets over HTTP/2 (RFC8441) #5565

Closed

bt90 mentioned this pull request Sep 30, 2024

Tracing doesn't log all SETTINGS parameters curl/curl#15093

Closed

use WebSocket instead of Websocket in the headers

0097468

WeidiDeng marked this pull request as ready for review November 26, 2024 01:06

WeidiDeng added 3 commits November 26, 2024 09:28

Merge branch 'master' into reverse-proxy-h2-websocket

af10f23

use logger check for zap loggers

12e5c5d

fix lint

182153e

mholt approved these changes Nov 26, 2024

View reviewed changes

francislavoie added upstream ⬆️ Relates to some dependency of this project go Pull requests that update Go code labels Nov 26, 2024

Merge branch 'master' into reverse-proxy-h2-websocket

c9faf72

francislavoie changed the title ~~reverse proxy: rewrite requests and responses for websocket over http2~~ reverseproxy: Rewrite requests and responses for websocket over http2 Dec 5, 2024

mholt approved these changes Dec 6, 2024

View reviewed changes

mholt merged commit 9c0c71e into master Dec 6, 2024

mholt deleted the reverse-proxy-h2-websocket branch December 6, 2024 20:23

BrewTestBot mentioned this pull request Dec 31, 2024

caddy 2.9.0 Homebrew/homebrew-core#202862

Merged

1 task

Uh oh!

Conversation

WeidiDeng commented Sep 10, 2024

Uh oh!

mholt commented Sep 10, 2024

Uh oh!

bt90 commented Sep 29, 2024

Uh oh!

WeidiDeng commented Sep 30, 2024

Uh oh!

bt90 commented Oct 5, 2024

Uh oh!

WeidiDeng commented Nov 26, 2024

Uh oh!

mholt left a comment

Choose a reason for hiding this comment

Uh oh!

WeidiDeng commented Dec 5, 2024

Uh oh!

bt90 commented Dec 5, 2024

Uh oh!

WeidiDeng commented Dec 5, 2024

Uh oh!

francislavoie commented Dec 5, 2024

Uh oh!

WeidiDeng commented Dec 6, 2024

Uh oh!

mholt left a comment

Choose a reason for hiding this comment

Uh oh!

jeda commented Dec 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bt90 commented Dec 11, 2024

Uh oh!

WeidiDeng commented Dec 11, 2024

Uh oh!

jeda commented Dec 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jeda commented Dec 11, 2024 •

edited

Loading

jeda commented Dec 11, 2024 •

edited

Loading